ZipProvider Class Reference

Inheritance diagram for ZipProvider:

List of all members.

Public Member Functions
	__construct (Folder $folder, $recursion=FALSE, $tempFile=null)
	__destruct ()
	setRecursion ($recursion)
	getRecursion ()
	setTempFile ($tempFile)
	getTempFile ()
	setFolder (Folder $folder)
	getFolder ()
	createArchive ()
	sendArchive ()
Static Public Member Functions
static	checkArchiveSize (Folder $folder, $recursion)
Private Member Functions
	logFolderDownload (Folder $folder)
Private Attributes
	$folder
	$recursion
	$tempFile

---

Detailed Description

Provides a zip archive of a folder.

Author:

Bjoern Kasteleiner <bjoern.kasteleiner@mni.fh-giessen.de>

Version:

Id

class.zipprovider.inc.php 2348 2009-06-04 13:29:47Z commana

Definition at line 41 of file class.zipprovider.inc.php.

---

Constructor & Destructor Documentation

ZipProvider::__construct	(	Folder $	folder,
		$	recursion = FALSE,
		$	tempFile = null
	)

Constructor for ZipProvider class.

Basic checks of incomming values. If $tempFile is null, the upload_path is used to create a temporary file for zip creation.

Parameters:

	Folder	$folder Folder
	Boolean	$recursion Recursion flag (Default: False)
	String	$tempFile Temporary filepath (Default: null)

Implements ArchiveProvider.

Definition at line 57 of file class.zipprovider.inc.php.

References $recursion, and $tempFile.

                                                                                          {
                assert(!is_null($folder));
                assert($folder instanceof Folder);
                
                global $settings;
                
                $this->folder = $folder;
                $this->recursion = $recursion;
                
                if (empty($tempFile)) {
                        $basedir  = PATH_TO_ROOT.$settings["upload_path"];
                        $basedir .= 'filemanager/courseID/'.$_SESSION['course'];
                        
                        $tempFile = tempnam($basedir, "archiver");
                } 
                
                $this->tempFile = $tempFile;
        }

ZipProvider::__destruct

(

)

Destructor of ZipProvider.

Used to clean up temporary files if needed.

Implements ArchiveProvider.

Definition at line 82 of file class.zipprovider.inc.php.

                                     {
                if (file_exists($this->tempFile)) {
                        unlink($this->tempFile); 
                }
        }

---

Member Function Documentation

static ZipProvider::checkArchiveSize	(	Folder $	folder,
		$	recursion
	)			[static]

Check archive filesizes.

Calculate the filesize of the folder and its subfolders.

Parameters:

	Folder	$folder Folder
	Boolean	$recursion Recursion flag

Returns:

Integer Size of folder and subfolders

Implements ArchiveProvider.

Definition at line 222 of file class.zipprovider.inc.php.

References $recursion, Folder::getFiles(), and Folder::getSubFolders().

Referenced by Filemanager::getArchivedFolder(), and Folder::getUserIcons().

                                                                            {
                global $resDB;

                $size = 0;
                
                $files = $folder->getFiles();
                foreach ($files as $file) {
                        $size += $file->getSize();
                }
                
                if ($recursion) {
                        $subFolders = $folder->getSubFolders();
                        foreach ($subFolders as $subFolder) {
                                $size += self::checkArchiveSize($subFolder, $recursion);
                        }       
                }
                
                return $size;
        }

ZipProvider::createArchive

(

)

Create an archive of the given Folder.

With or without subfolders, depending on recursion flag.

Implements ArchiveProvider.

Definition at line 147 of file class.zipprovider.inc.php.

                                        {
                $zipArchiver = new ZipArchive();
                if ($zipArchiver->open($this->tempFile, ZipArchive::OVERWRITE) !== TRUE) {
                        throw new ArchiverException("Fehler beim Anlegen des Archivs. ".$this->tempFile);
                }
                
                $zipVisitor = new ZipVisitor($zipArchiver, $this->recursion);
                $this->folder->archiverAccept($zipVisitor); 
                
                if ($zipArchiver->status != ZipArchive::ER_OK) {
                        throw new ArchiverException("Fehler beim Erzeugen des Archivs: ".$zipArchiver->status);
                }
                $zipArchiver->close();
        }

ZipProvider::getFolder

(

)

Getter for archiving folder.

Returns:

Folder Folder

Implements ArchiveProvider.

Definition at line 138 of file class.zipprovider.inc.php.

                                    {
                return $this->folder;
        }

ZipProvider::getRecursion

(

)

Getter for recursion flag.

Returns:

Boolean Recursion flag

Implements ArchiveProvider.

Definition at line 102 of file class.zipprovider.inc.php.

                                       {
                return $this->recursion;
        }

ZipProvider::getTempFile

(

)

Getter for temporary file.

Returns:

String Temporary filepath

Implements ArchiveProvider.

Definition at line 120 of file class.zipprovider.inc.php.

                                      {
                return $this->tempFile;
        }

ZipProvider::logFolderDownload

(

Folder $

folder

)

[private]

Logging folder download and increment folder download count.

Parameters:

Folder

$folder Folder

Definition at line 194 of file class.zipprovider.inc.php.

References Folder::getFiles(), Resource::getID(), and Folder::getSubFolders().

Referenced by sendArchive().

                                                           {
                global $resDB;
                
                $resDB->logResourceDownload($folder->getID());
                
                $files = $folder->getFiles();
                foreach ($files as $file) {
                        $resDB->logResourceDownload($file->getID());
                }
                
                if ($this->recursion) {
                        $subFolders = $folder->getSubFolders();
                        foreach ($subFolders as $subFolder) {
                                $this->logFolderDownload($subFolder);
                        }
                }
        }

ZipProvider::sendArchive

(

)

Send archive to the client.

Send needed header informations and logging folder download and increment folder download count.

Implements ArchiveProvider.

Definition at line 168 of file class.zipprovider.inc.php.

References logFolderDownload().

                                      {
                global $resDB;
                
        if (file_exists($this->tempFile)) {
                $filename  = $resDB->getCourseShortNameByID($this->folder->getCourseID());
                $filename .= "-".$this->folder->getLink().".zip";
                
                $this->logFolderDownload($this->folder);
                
                header("Content-Type: application/zip");
                header("Content-Disposition: attachment; filename=\"".$filename."\"");
                header("Content-Transfer-Encoding: binary");
                header("Content-Length: ".filesize($this->tempFile));
                
                readfile($this->tempFile);
                unlink($this->tempFile);
        } else {
                throw new ArchiverException("Bereitgestelltes Zip Archive konnte nicht gefunden werden.");
        }
        }

ZipProvider::setFolder

(

Folder $

folder

)

Setter for archiving folder.

Parameters:

Folder

$folder Folder

Implements ArchiveProvider.

Definition at line 129 of file class.zipprovider.inc.php.

                                                  {
                $this->folder = $folder;
        }

ZipProvider::setRecursion

(

$

recursion

)

Setter for recursion flag.

Parameters:

Boolean

$recursion Recursion flag

Implements ArchiveProvider.

Definition at line 93 of file class.zipprovider.inc.php.

References $recursion.

                                                 {
                $this->recursion = $recursion;
        }

ZipProvider::setTempFile

(

$

tempFile

)

Setter for temporary file.

Parameters:

String

$tempFile Temporary filepath

Implements ArchiveProvider.

Definition at line 111 of file class.zipprovider.inc.php.

References $tempFile.

                                               {
                $this->tempFile = $tempFile;
        }

---

Member Data Documentation

ZipProvider::$folder [private]

Definition at line 42 of file class.zipprovider.inc.php.

ZipProvider::$recursion [private]

Definition at line 43 of file class.zipprovider.inc.php.

Referenced by __construct(), checkArchiveSize(), and setRecursion().

ZipProvider::$tempFile [private]

Definition at line 44 of file class.zipprovider.inc.php.

Referenced by __construct(), and setTempFile().

---

The documentation for this class was generated from the following file:

• classes/archiver/class.zipprovider.inc.php